<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SQLKVDatabase.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.kv.sql;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.sql.Connection;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.sql.SQLException;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.sql.SQLRecoverableException;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.sql.SQLTimeoutException;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.sql.SQLTransientException;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>import javax.sql.DataSource;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.jsimpledb.kv.KVDatabase;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.jsimpledb.kv.KVDatabaseException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.jsimpledb.kv.KVTransactionException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.jsimpledb.kv.RetryTransactionException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.jsimpledb.kv.TransactionTimeoutException;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * Support superclass for SQL {@link KVDatabase} implementations.<a name="line.25"></a>
<span class="sourceLineNo">026</span> */<a name="line.26"></a>
<span class="sourceLineNo">027</span>public class SQLKVDatabase implements KVDatabase {<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>    /**<a name="line.29"></a>
<span class="sourceLineNo">030</span>     * Default table name ({@value #DEFAULT_TABLE_NAME}).<a name="line.30"></a>
<span class="sourceLineNo">031</span>     */<a name="line.31"></a>
<span class="sourceLineNo">032</span>    public static final String DEFAULT_TABLE_NAME = "KV";<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    /**<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * Default key column name ({@value #DEFAULT_KEY_COLUMN_NAME}).<a name="line.35"></a>
<span class="sourceLineNo">036</span>     */<a name="line.36"></a>
<span class="sourceLineNo">037</span>    public static final String DEFAULT_KEY_COLUMN_NAME = "kv_key";<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>    /**<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * Default value column name ({@value #DEFAULT_VALUE_COLUMN_NAME}).<a name="line.40"></a>
<span class="sourceLineNo">041</span>     */<a name="line.41"></a>
<span class="sourceLineNo">042</span>    public static final String DEFAULT_VALUE_COLUMN_NAME = "kv_value";<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>    protected DataSource dataSource;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>    /**<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * The name of the key/value table. Default value is {@value #DEFAULT_TABLE_NAME}.<a name="line.47"></a>
<span class="sourceLineNo">048</span>     */<a name="line.48"></a>
<span class="sourceLineNo">049</span>    protected String tableName = DEFAULT_TABLE_NAME;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>    /**<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * The name of the key column. Default value is {@value #DEFAULT_KEY_COLUMN_NAME}.<a name="line.52"></a>
<span class="sourceLineNo">053</span>     */<a name="line.53"></a>
<span class="sourceLineNo">054</span>    protected String keyColumnName = DEFAULT_KEY_COLUMN_NAME;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    /**<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * The name of the value column. Default value is {@value #DEFAULT_VALUE_COLUMN_NAME}.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     */<a name="line.58"></a>
<span class="sourceLineNo">059</span>    protected String valueColumnName = DEFAULT_VALUE_COLUMN_NAME;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>    /**<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * The configured transaction isolation level. Default is {@link IsolationLevel#SERIALIZABLE}.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     */<a name="line.63"></a>
<span class="sourceLineNo">064</span>    protected IsolationLevel isolationLevel = IsolationLevel.SERIALIZABLE;<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    /**<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * Get the {@link DataSource} used with this instance.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     *<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * @return the associated {@link DataSource}<a name="line.69"></a>
<span class="sourceLineNo">070</span>     */<a name="line.70"></a>
<span class="sourceLineNo">071</span>    public DataSource getDataSource() {<a name="line.71"></a>
<span class="sourceLineNo">072</span>        return this.dataSource;<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /**<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * Configure the {@link DataSource} used with this instance.<a name="line.76"></a>
<span class="sourceLineNo">077</span>     *<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * &lt;p&gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * Required property.<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * &lt;/p&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span>     *<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param dataSource access to the underlying database<a name="line.82"></a>
<span class="sourceLineNo">083</span>     */<a name="line.83"></a>
<span class="sourceLineNo">084</span>    public void setDataSource(DataSource dataSource) {<a name="line.84"></a>
<span class="sourceLineNo">085</span>        this.dataSource = dataSource;<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * Get the name of the table containing keys and values.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     *<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * &lt;p&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * Default value is {@value #DEFAULT_TABLE_NAME}.<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * &lt;/p&gt;<a name="line.93"></a>
<span class="sourceLineNo">094</span>     *<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @return key/value table name<a name="line.95"></a>
<span class="sourceLineNo">096</span>     */<a name="line.96"></a>
<span class="sourceLineNo">097</span>    public String getTableName() {<a name="line.97"></a>
<span class="sourceLineNo">098</span>        return this.tableName;<a name="line.98"></a>
<span class="sourceLineNo">099</span>    }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span>    /**<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * Set the name of the key/value table.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * @param tableName the name of the key/value table<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * @throws IllegalArgumentException if {@code table} is null<a name="line.105"></a>
<span class="sourceLineNo">106</span>     */<a name="line.106"></a>
<span class="sourceLineNo">107</span>    public void setTableName(String tableName) {<a name="line.107"></a>
<span class="sourceLineNo">108</span>        if (tableName == null)<a name="line.108"></a>
<span class="sourceLineNo">109</span>            throw new IllegalArgumentException("null tableName");<a name="line.109"></a>
<span class="sourceLineNo">110</span>        this.tableName = tableName;<a name="line.110"></a>
<span class="sourceLineNo">111</span>    }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>    /**<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * Get the name of the column containing keys.<a name="line.114"></a>
<span class="sourceLineNo">115</span>     *<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * &lt;p&gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * Default value is {@value #DEFAULT_KEY_COLUMN_NAME}.<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * &lt;/p&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span>     *<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * @return the name of the key column<a name="line.120"></a>
<span class="sourceLineNo">121</span>     */<a name="line.121"></a>
<span class="sourceLineNo">122</span>    public String getKeyColumnName() {<a name="line.122"></a>
<span class="sourceLineNo">123</span>        return this.keyColumnName;<a name="line.123"></a>
<span class="sourceLineNo">124</span>    }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span>    /**<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * Configure the name of the column containing keys.<a name="line.127"></a>
<span class="sourceLineNo">128</span>     *<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * @param keyColumnName the name of the key column<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * @throws IllegalArgumentException if {@code keyColumnName} is null<a name="line.130"></a>
<span class="sourceLineNo">131</span>     */<a name="line.131"></a>
<span class="sourceLineNo">132</span>    public void setKeyColumnName(String keyColumnName) {<a name="line.132"></a>
<span class="sourceLineNo">133</span>        if (keyColumnName == null)<a name="line.133"></a>
<span class="sourceLineNo">134</span>            throw new IllegalArgumentException("null keyColumn");<a name="line.134"></a>
<span class="sourceLineNo">135</span>        this.keyColumnName = keyColumnName;<a name="line.135"></a>
<span class="sourceLineNo">136</span>    }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span>    /**<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * Get the name of the column containing values.<a name="line.139"></a>
<span class="sourceLineNo">140</span>     *<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * &lt;p&gt;<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * Default value is {@value #DEFAULT_VALUE_COLUMN_NAME}.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * &lt;/p&gt;<a name="line.143"></a>
<span class="sourceLineNo">144</span>     *<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * @return the name of the value column<a name="line.145"></a>
<span class="sourceLineNo">146</span>     */<a name="line.146"></a>
<span class="sourceLineNo">147</span>    public String getValueColumnName() {<a name="line.147"></a>
<span class="sourceLineNo">148</span>        return this.valueColumnName;<a name="line.148"></a>
<span class="sourceLineNo">149</span>    }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span>    /**<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * Configure the name of the column containing values.<a name="line.152"></a>
<span class="sourceLineNo">153</span>     *<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @param valueColumnName the name of the value column<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @throws IllegalArgumentException if {@code valueColumnName} is null<a name="line.155"></a>
<span class="sourceLineNo">156</span>     */<a name="line.156"></a>
<span class="sourceLineNo">157</span>    public void setValueColumnName(String valueColumnName) {<a name="line.157"></a>
<span class="sourceLineNo">158</span>        if (valueColumnName == null)<a name="line.158"></a>
<span class="sourceLineNo">159</span>            throw new IllegalArgumentException("null valueColumn");<a name="line.159"></a>
<span class="sourceLineNo">160</span>        this.valueColumnName = valueColumnName;<a name="line.160"></a>
<span class="sourceLineNo">161</span>    }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>    /**<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * Get the transaction isolation level.<a name="line.164"></a>
<span class="sourceLineNo">165</span>     *<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * &lt;p&gt;<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * Default value is {@link IsolationLevel#SERIALIZABLE}.<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * &lt;/p&gt;<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * @return isolation level<a name="line.170"></a>
<span class="sourceLineNo">171</span>     */<a name="line.171"></a>
<span class="sourceLineNo">172</span>    public IsolationLevel getIsolationLevel() {<a name="line.172"></a>
<span class="sourceLineNo">173</span>        return this.isolationLevel;<a name="line.173"></a>
<span class="sourceLineNo">174</span>    }<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span>    /**<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * Configure the transaction isolation level.<a name="line.177"></a>
<span class="sourceLineNo">178</span>     *<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * @param isolationLevel isolation level<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * @throws IllegalArgumentException if {@code isolationLevel} is null<a name="line.180"></a>
<span class="sourceLineNo">181</span>     */<a name="line.181"></a>
<span class="sourceLineNo">182</span>    public void setIsolationLevel(IsolationLevel isolationLevel) {<a name="line.182"></a>
<span class="sourceLineNo">183</span>        if (isolationLevel == null)<a name="line.183"></a>
<span class="sourceLineNo">184</span>            throw new IllegalArgumentException("null isolationLevel");<a name="line.184"></a>
<span class="sourceLineNo">185</span>        this.isolationLevel = isolationLevel;<a name="line.185"></a>
<span class="sourceLineNo">186</span>    }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span>    /**<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * Create a new transaction.<a name="line.189"></a>
<span class="sourceLineNo">190</span>     *<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * &lt;p&gt;<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * The implementation in {@link SQLKVDatabase} invokes {@link #createTransactionConnection createTransactionConnection()}<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * to get a {@link Connection} for the new transaction, then invokes these methods in order:<a name="line.193"></a>
<span class="sourceLineNo">194</span>     *  &lt;ol&gt;<a name="line.194"></a>
<span class="sourceLineNo">195</span>     *  &lt;li&gt;{@link #preBeginTransaction preBeginTransaction()}&lt;/li&gt;<a name="line.195"></a>
<span class="sourceLineNo">196</span>     *  &lt;li&gt;{@link #beginTransaction beginTransaction()}&lt;/li&gt;<a name="line.196"></a>
<span class="sourceLineNo">197</span>     *  &lt;li&gt;{@link #postBeginTransaction postBeginTransaction()}&lt;/li&gt;<a name="line.197"></a>
<span class="sourceLineNo">198</span>     *  &lt;li&gt;{@link #createSQLKVTransaction createSQLKVTransaction()}&lt;/li&gt;<a name="line.198"></a>
<span class="sourceLineNo">199</span>     *  &lt;/ol&gt;<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * and returns the result.<a name="line.200"></a>
<span class="sourceLineNo">201</span>     *<a name="line.201"></a>
<span class="sourceLineNo">202</span>     * @throws KVDatabaseException if an unexpected error occurs<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * @throws IllegalStateException if no {@link DataSource} is {@linkplain #setDataSource configured}<a name="line.203"></a>
<span class="sourceLineNo">204</span>     */<a name="line.204"></a>
<span class="sourceLineNo">205</span>    @Override<a name="line.205"></a>
<span class="sourceLineNo">206</span>    public SQLKVTransaction createTransaction() {<a name="line.206"></a>
<span class="sourceLineNo">207</span>        if (this.dataSource == null)<a name="line.207"></a>
<span class="sourceLineNo">208</span>            throw new IllegalStateException("no DataSource configured");<a name="line.208"></a>
<span class="sourceLineNo">209</span>        try {<a name="line.209"></a>
<span class="sourceLineNo">210</span>            final Connection connection = this.createTransactionConnection();<a name="line.210"></a>
<span class="sourceLineNo">211</span>            this.preBeginTransaction(connection);<a name="line.211"></a>
<span class="sourceLineNo">212</span>            this.beginTransaction(connection);<a name="line.212"></a>
<span class="sourceLineNo">213</span>            this.postBeginTransaction(connection);<a name="line.213"></a>
<span class="sourceLineNo">214</span>            return this.createSQLKVTransaction(connection);<a name="line.214"></a>
<span class="sourceLineNo">215</span>        } catch (SQLException e) {<a name="line.215"></a>
<span class="sourceLineNo">216</span>            throw new KVDatabaseException(this, e);<a name="line.216"></a>
<span class="sourceLineNo">217</span>        }<a name="line.217"></a>
<span class="sourceLineNo">218</span>    }<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span>    /**<a name="line.220"></a>
<span class="sourceLineNo">221</span>     * Create a {@link Connection} for a new transaction.<a name="line.221"></a>
<span class="sourceLineNo">222</span>     *<a name="line.222"></a>
<span class="sourceLineNo">223</span>     * &lt;p&gt;<a name="line.223"></a>
<span class="sourceLineNo">224</span>     * The implementation in {@link SQLKVDatabase} invokes {@link DataSource#getConnection()} on the<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * {@linkplain #dataSource configured} {@link DataSource}.<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * &lt;/p&gt;<a name="line.226"></a>
<span class="sourceLineNo">227</span>     *<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * @return new transaction {@link Connection}<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * @throws SQLException if an error occurs<a name="line.229"></a>
<span class="sourceLineNo">230</span>     */<a name="line.230"></a>
<span class="sourceLineNo">231</span>    protected Connection createTransactionConnection() throws SQLException {<a name="line.231"></a>
<span class="sourceLineNo">232</span>        return this.dataSource.getConnection();<a name="line.232"></a>
<span class="sourceLineNo">233</span>    }<a name="line.233"></a>
<span class="sourceLineNo">234</span><a name="line.234"></a>
<span class="sourceLineNo">235</span>    /**<a name="line.235"></a>
<span class="sourceLineNo">236</span>     * Subclass hook invoked just before opening a new SQL transaction.<a name="line.236"></a>
<span class="sourceLineNo">237</span>     *<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * &lt;p&gt;<a name="line.238"></a>
<span class="sourceLineNo">239</span>     * The implementation in {@link SQLKVDatabase} does nothing. Note: subclasses must ensure the transaction is<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * configured for the {@link IsolationLevel} configured on this instance.<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * &lt;/p&gt;<a name="line.241"></a>
<span class="sourceLineNo">242</span>     *<a name="line.242"></a>
<span class="sourceLineNo">243</span>     * @param connection the {@link Connection} for a new transaction<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * @throws SQLException if an error occurs<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * @see #createSQLKVTransaction createSQLKVTransaction()<a name="line.245"></a>
<span class="sourceLineNo">246</span>     */<a name="line.246"></a>
<span class="sourceLineNo">247</span>    protected void preBeginTransaction(Connection connection) throws SQLException {<a name="line.247"></a>
<span class="sourceLineNo">248</span>    }<a name="line.248"></a>
<span class="sourceLineNo">249</span><a name="line.249"></a>
<span class="sourceLineNo">250</span>    /**<a name="line.250"></a>
<span class="sourceLineNo">251</span>     * Open a new SQL transaction on the given {@link Connection}.<a name="line.251"></a>
<span class="sourceLineNo">252</span>     *<a name="line.252"></a>
<span class="sourceLineNo">253</span>     * &lt;p&gt;<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * The implementation in {@link SQLKVDatabase} invokes {@link Connection#setAutoCommit Connection.setAutoCommit(false)}.<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * &lt;/p&gt;<a name="line.255"></a>
<span class="sourceLineNo">256</span>     *<a name="line.256"></a>
<span class="sourceLineNo">257</span>     * @param connection the {@link Connection} for a new transaction<a name="line.257"></a>
<span class="sourceLineNo">258</span>     * @throws SQLException if an error occurs<a name="line.258"></a>
<span class="sourceLineNo">259</span>     * @see #createSQLKVTransaction createSQLKVTransaction()<a name="line.259"></a>
<span class="sourceLineNo">260</span>     */<a name="line.260"></a>
<span class="sourceLineNo">261</span>    protected void beginTransaction(Connection connection) throws SQLException {<a name="line.261"></a>
<span class="sourceLineNo">262</span>        connection.setAutoCommit(false);<a name="line.262"></a>
<span class="sourceLineNo">263</span>    }<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span>    /**<a name="line.265"></a>
<span class="sourceLineNo">266</span>     * Subclass hook invoked just after opening a new SQL transaction.<a name="line.266"></a>
<span class="sourceLineNo">267</span>     *<a name="line.267"></a>
<span class="sourceLineNo">268</span>     * &lt;p&gt;<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * The implementation in {@link SQLKVDatabase} does nothing. Note: subclasses must ensure the transaction is<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * configured for the {@link IsolationLevel} configured on this instance.<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * &lt;/p&gt;<a name="line.271"></a>
<span class="sourceLineNo">272</span>     *<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * @param connection the {@link Connection} for a new transaction<a name="line.273"></a>
<span class="sourceLineNo">274</span>     * @throws SQLException if an error occurs<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * @see #createSQLKVTransaction createSQLKVTransaction()<a name="line.275"></a>
<span class="sourceLineNo">276</span>     */<a name="line.276"></a>
<span class="sourceLineNo">277</span>    protected void postBeginTransaction(Connection connection) throws SQLException {<a name="line.277"></a>
<span class="sourceLineNo">278</span>    }<a name="line.278"></a>
<span class="sourceLineNo">279</span><a name="line.279"></a>
<span class="sourceLineNo">280</span>    /**<a name="line.280"></a>
<span class="sourceLineNo">281</span>     * Create a new {@link SQLKVTransaction} for a new transaction given the specified {@link Connection}.<a name="line.281"></a>
<span class="sourceLineNo">282</span>     * There will already be an SQL transaction open on {@code connection}.<a name="line.282"></a>
<span class="sourceLineNo">283</span>     *<a name="line.283"></a>
<span class="sourceLineNo">284</span>     * &lt;p&gt;<a name="line.284"></a>
<span class="sourceLineNo">285</span>     * The implementation in {@link SQLKVDatabase} just invokes<a name="line.285"></a>
<span class="sourceLineNo">286</span>     * {@link SQLKVTransaction#SQLKVTransaction new SQLKVTransaction(this, connection)}.<a name="line.286"></a>
<span class="sourceLineNo">287</span>     * &lt;/p&gt;<a name="line.287"></a>
<span class="sourceLineNo">288</span>     *<a name="line.288"></a>
<span class="sourceLineNo">289</span>     * @param connection the {@link Connection} for a new transaction<a name="line.289"></a>
<span class="sourceLineNo">290</span>     * @return newly created transaction<a name="line.290"></a>
<span class="sourceLineNo">291</span>     * @throws SQLException if an error occurs<a name="line.291"></a>
<span class="sourceLineNo">292</span>     */<a name="line.292"></a>
<span class="sourceLineNo">293</span>    protected SQLKVTransaction createSQLKVTransaction(Connection connection) throws SQLException {<a name="line.293"></a>
<span class="sourceLineNo">294</span>        return new SQLKVTransaction(this, connection);<a name="line.294"></a>
<span class="sourceLineNo">295</span>    }<a name="line.295"></a>
<span class="sourceLineNo">296</span><a name="line.296"></a>
<span class="sourceLineNo">297</span>    /**<a name="line.297"></a>
<span class="sourceLineNo">298</span>     * Create an SQL statement that reads the value column associated with key &lt;code&gt;&amp;#63;1&lt;/code&gt;.<a name="line.298"></a>
<span class="sourceLineNo">299</span>     *<a name="line.299"></a>
<span class="sourceLineNo">300</span>     * @return SQL query statement<a name="line.300"></a>
<span class="sourceLineNo">301</span>     */<a name="line.301"></a>
<span class="sourceLineNo">302</span>    public String createGetStatement() {<a name="line.302"></a>
<span class="sourceLineNo">303</span>        return "SELECT " + this.quote(this.valueColumnName) + " FROM "<a name="line.303"></a>
<span class="sourceLineNo">304</span>          + this.quote(this.tableName) + " WHERE " + this.quote(this.keyColumnName) + " = ?";<a name="line.304"></a>
<span class="sourceLineNo">305</span>    }<a name="line.305"></a>
<span class="sourceLineNo">306</span><a name="line.306"></a>
<span class="sourceLineNo">307</span>    /**<a name="line.307"></a>
<span class="sourceLineNo">308</span>     * Create an SQL statement that reads the key and value columns (in that order) associated<a name="line.308"></a>
<span class="sourceLineNo">309</span>     * with the smallest key greater than or equal to &lt;code&gt;&amp;#63;1&lt;/code&gt;, if any.<a name="line.309"></a>
<span class="sourceLineNo">310</span>     *<a name="line.310"></a>
<span class="sourceLineNo">311</span>     * @param reverse true to return rows in descending key order, false to return rows in ascending key order<a name="line.311"></a>
<span class="sourceLineNo">312</span>     * @return SQL query statement<a name="line.312"></a>
<span class="sourceLineNo">313</span>     */<a name="line.313"></a>
<span class="sourceLineNo">314</span>    public String createGetAtLeastStatement(boolean reverse) {<a name="line.314"></a>
<span class="sourceLineNo">315</span>        return "SELECT " + this.quote(this.keyColumnName) + ", " + this.quote(this.valueColumnName)<a name="line.315"></a>
<span class="sourceLineNo">316</span>          + " FROM " + this.quote(this.tableName) + " WHERE " + this.quote(this.keyColumnName)<a name="line.316"></a>
<span class="sourceLineNo">317</span>          + " &gt;= ? ORDER BY " + this.quote(this.keyColumnName) + (reverse ? " DESC" : " ASC");<a name="line.317"></a>
<span class="sourceLineNo">318</span>    }<a name="line.318"></a>
<span class="sourceLineNo">319</span><a name="line.319"></a>
<span class="sourceLineNo">320</span>    /**<a name="line.320"></a>
<span class="sourceLineNo">321</span>     * Create an SQL statement that reads the key and value columns (in that order)<a name="line.321"></a>
<span class="sourceLineNo">322</span>     * associated with the greatest key strictly less than &lt;code&gt;&amp;#63;1&lt;/code&gt;, if any.<a name="line.322"></a>
<span class="sourceLineNo">323</span>     *<a name="line.323"></a>
<span class="sourceLineNo">324</span>     * @param reverse true to return rows in descending key order, false to return rows in ascending key order<a name="line.324"></a>
<span class="sourceLineNo">325</span>     * @return SQL query statement<a name="line.325"></a>
<span class="sourceLineNo">326</span>     */<a name="line.326"></a>
<span class="sourceLineNo">327</span>    public String createGetAtMostStatement(boolean reverse) {<a name="line.327"></a>
<span class="sourceLineNo">328</span>        return "SELECT " + this.quote(this.keyColumnName) + ", " + this.quote(this.valueColumnName)<a name="line.328"></a>
<span class="sourceLineNo">329</span>          + " FROM " + this.quote(this.tableName) + " WHERE " + this.quote(this.keyColumnName)<a name="line.329"></a>
<span class="sourceLineNo">330</span>          + " &lt; ? ORDER BY " + this.quote(this.keyColumnName) + (reverse ? " DESC" : " ASC");<a name="line.330"></a>
<span class="sourceLineNo">331</span>    }<a name="line.331"></a>
<span class="sourceLineNo">332</span><a name="line.332"></a>
<span class="sourceLineNo">333</span>    /**<a name="line.333"></a>
<span class="sourceLineNo">334</span>     * Create an SQL statement that reads the key and value columns (in that order) associated with all keys<a name="line.334"></a>
<span class="sourceLineNo">335</span>     * in the range &lt;code&gt;&amp;#63;1&lt;/code&gt; (inclusive) to &lt;code&gt;&amp;#63;2&lt;/code&gt; (exclusive), possibly reversed.<a name="line.335"></a>
<span class="sourceLineNo">336</span>     *<a name="line.336"></a>
<span class="sourceLineNo">337</span>     * @param reverse true to return rows in descending key order, false to return rows in ascending key order<a name="line.337"></a>
<span class="sourceLineNo">338</span>     * @return SQL query statement<a name="line.338"></a>
<span class="sourceLineNo">339</span>     */<a name="line.339"></a>
<span class="sourceLineNo">340</span>    public String createGetRangeStatement(boolean reverse) {<a name="line.340"></a>
<span class="sourceLineNo">341</span>        return "SELECT " + this.quote(this.keyColumnName) + ", " + this.quote(this.valueColumnName)<a name="line.341"></a>
<span class="sourceLineNo">342</span>          + " FROM " + this.quote(this.tableName) + " WHERE " + this.quote(this.keyColumnName)<a name="line.342"></a>
<span class="sourceLineNo">343</span>          + " &gt;= ? and " + this.quote(this.keyColumnName) + " &lt; ? ORDER BY " + this.quote(this.keyColumnName)<a name="line.343"></a>
<span class="sourceLineNo">344</span>          + (reverse ? " DESC" : " ASC");<a name="line.344"></a>
<span class="sourceLineNo">345</span>    }<a name="line.345"></a>
<span class="sourceLineNo">346</span><a name="line.346"></a>
<span class="sourceLineNo">347</span>    /**<a name="line.347"></a>
<span class="sourceLineNo">348</span>     * Create an SQL statement that reads all of the key and value columns (in that order), possibly reversed.<a name="line.348"></a>
<span class="sourceLineNo">349</span>     *<a name="line.349"></a>
<span class="sourceLineNo">350</span>     * @param reverse true to return rows in descending key order, false to return rows in ascending key order<a name="line.350"></a>
<span class="sourceLineNo">351</span>     * @return SQL query statement<a name="line.351"></a>
<span class="sourceLineNo">352</span>     */<a name="line.352"></a>
<span class="sourceLineNo">353</span>    public String createGetAllStatement(boolean reverse) {<a name="line.353"></a>
<span class="sourceLineNo">354</span>        return "SELECT " + this.quote(this.keyColumnName) + ", " + this.quote(this.valueColumnName)<a name="line.354"></a>
<span class="sourceLineNo">355</span>          + " FROM " + this.quote(this.tableName) + " ORDER BY " + this.quote(this.keyColumnName) + (reverse ? " DESC" : " ASC");<a name="line.355"></a>
<span class="sourceLineNo">356</span>    }<a name="line.356"></a>
<span class="sourceLineNo">357</span><a name="line.357"></a>
<span class="sourceLineNo">358</span>    /**<a name="line.358"></a>
<span class="sourceLineNo">359</span>     * Create an SQL statement that inserts the key/value pair with key &lt;code&gt;&amp;#63;1&lt;/code&gt; and value &lt;code&gt;&amp;#63;2&lt;/code&gt;<a name="line.359"></a>
<span class="sourceLineNo">360</span>     * A row with key &lt;code&gt;&amp;#63;1&lt;/code&gt; may already exist; if so, the value should be updated to &lt;code&gt;&amp;#63;3&lt;/code&gt;.<a name="line.360"></a>
<span class="sourceLineNo">361</span>     *<a name="line.361"></a>
<span class="sourceLineNo">362</span>     * @return SQL insertion statement<a name="line.362"></a>
<span class="sourceLineNo">363</span>     */<a name="line.363"></a>
<span class="sourceLineNo">364</span>    public String createPutStatement() {<a name="line.364"></a>
<span class="sourceLineNo">365</span>        return "INSERT INTO " + this.quote(this.tableName) + " (" + this.quote(this.keyColumnName)<a name="line.365"></a>
<span class="sourceLineNo">366</span>          + ", " + this.quote(this.valueColumnName) + ") VALUES (?, ?) ON DUPLICATE KEY UPDATE "<a name="line.366"></a>
<span class="sourceLineNo">367</span>          + this.quote(this.valueColumnName) + " = ?";<a name="line.367"></a>
<span class="sourceLineNo">368</span>    }<a name="line.368"></a>
<span class="sourceLineNo">369</span><a name="line.369"></a>
<span class="sourceLineNo">370</span>    /**<a name="line.370"></a>
<span class="sourceLineNo">371</span>     * Create an SQL statement that deletes the row associated with key &lt;code&gt;&amp;#63;1&lt;/code&gt;, if any.<a name="line.371"></a>
<span class="sourceLineNo">372</span>     * Note that the key may or may not exist prior to this method being invoked.<a name="line.372"></a>
<span class="sourceLineNo">373</span>     *<a name="line.373"></a>
<span class="sourceLineNo">374</span>     * @return SQL delete statement<a name="line.374"></a>
<span class="sourceLineNo">375</span>     */<a name="line.375"></a>
<span class="sourceLineNo">376</span>    public String createRemoveStatement() {<a name="line.376"></a>
<span class="sourceLineNo">377</span>        return "DELETE FROM " + this.quote(this.tableName) + " WHERE " + this.quote(this.keyColumnName) + " = ?";<a name="line.377"></a>
<span class="sourceLineNo">378</span>    }<a name="line.378"></a>
<span class="sourceLineNo">379</span><a name="line.379"></a>
<span class="sourceLineNo">380</span>    /**<a name="line.380"></a>
<span class="sourceLineNo">381</span>     * Create an SQL statement that deletes all rows with keys in the range &lt;code&gt;&amp;#63;1&lt;/code&gt; (inclusive}<a name="line.381"></a>
<span class="sourceLineNo">382</span>     * to &lt;code&gt;&amp;#63;2&lt;/code&gt; (exclusive).<a name="line.382"></a>
<span class="sourceLineNo">383</span>     *<a name="line.383"></a>
<span class="sourceLineNo">384</span>     * @return SQL delete statement<a name="line.384"></a>
<span class="sourceLineNo">385</span>     */<a name="line.385"></a>
<span class="sourceLineNo">386</span>    public String createRemoveRangeStatement() {<a name="line.386"></a>
<span class="sourceLineNo">387</span>        return "DELETE FROM " + this.quote(this.tableName)<a name="line.387"></a>
<span class="sourceLineNo">388</span>          + " WHERE " + this.quote(this.keyColumnName) + " &gt;= ? AND " + this.quote(this.keyColumnName) + " &lt; ?";<a name="line.388"></a>
<span class="sourceLineNo">389</span>    }<a name="line.389"></a>
<span class="sourceLineNo">390</span><a name="line.390"></a>
<span class="sourceLineNo">391</span>    /**<a name="line.391"></a>
<span class="sourceLineNo">392</span>     * Create an SQL statement that deletes all rows with keys greater than or equal to &lt;code&gt;&amp;#63;1&lt;/code&gt;.<a name="line.392"></a>
<span class="sourceLineNo">393</span>     *<a name="line.393"></a>
<span class="sourceLineNo">394</span>     * @return SQL delete statement<a name="line.394"></a>
<span class="sourceLineNo">395</span>     */<a name="line.395"></a>
<span class="sourceLineNo">396</span>    public String createRemoveAtLeastStatement() {<a name="line.396"></a>
<span class="sourceLineNo">397</span>        return "DELETE FROM " + this.quote(this.tableName) + " WHERE " + this.quote(this.keyColumnName) + " &gt;= ?";<a name="line.397"></a>
<span class="sourceLineNo">398</span>    }<a name="line.398"></a>
<span class="sourceLineNo">399</span><a name="line.399"></a>
<span class="sourceLineNo">400</span>    /**<a name="line.400"></a>
<span class="sourceLineNo">401</span>     * Create an SQL statement that deletes all rows with keys strictly less than &lt;code&gt;&amp;#63;1&lt;/code&gt;.<a name="line.401"></a>
<span class="sourceLineNo">402</span>     *<a name="line.402"></a>
<span class="sourceLineNo">403</span>     * @return SQL delete statement<a name="line.403"></a>
<span class="sourceLineNo">404</span>     */<a name="line.404"></a>
<span class="sourceLineNo">405</span>    public String createRemoveAtMostStatement() {<a name="line.405"></a>
<span class="sourceLineNo">406</span>        return "DELETE FROM " + this.quote(this.tableName) + " WHERE " + this.quote(this.keyColumnName) + " &lt; ?";<a name="line.406"></a>
<span class="sourceLineNo">407</span>    }<a name="line.407"></a>
<span class="sourceLineNo">408</span><a name="line.408"></a>
<span class="sourceLineNo">409</span>    /**<a name="line.409"></a>
<span class="sourceLineNo">410</span>     * Create an SQL statement that deletes all rows.<a name="line.410"></a>
<span class="sourceLineNo">411</span>     *<a name="line.411"></a>
<span class="sourceLineNo">412</span>     * @return SQL delete statement<a name="line.412"></a>
<span class="sourceLineNo">413</span>     */<a name="line.413"></a>
<span class="sourceLineNo">414</span>    public String createRemoveAllStatement() {<a name="line.414"></a>
<span class="sourceLineNo">415</span>        return "DELETE FROM " + this.quote(this.tableName);<a name="line.415"></a>
<span class="sourceLineNo">416</span>    }<a name="line.416"></a>
<span class="sourceLineNo">417</span><a name="line.417"></a>
<span class="sourceLineNo">418</span>    /**<a name="line.418"></a>
<span class="sourceLineNo">419</span>     * Modify the given SQL statement so that only one row is returned.<a name="line.419"></a>
<span class="sourceLineNo">420</span>     *<a name="line.420"></a>
<span class="sourceLineNo">421</span>     * &lt;p&gt;<a name="line.421"></a>
<span class="sourceLineNo">422</span>     * This is an optional method; returning {@code statement} unmodified is acceptable, but subclasses may<a name="line.422"></a>
<span class="sourceLineNo">423</span>     * be able to improve efficiency by modifying the SQL statement in a vendor-specific manner to only return one row.<a name="line.423"></a>
<span class="sourceLineNo">424</span>     * &lt;/p&gt;<a name="line.424"></a>
<span class="sourceLineNo">425</span>     *<a name="line.425"></a>
<span class="sourceLineNo">426</span>     * &lt;p&gt;<a name="line.426"></a>
<span class="sourceLineNo">427</span>     * The implementation in {@link SQLKVDatabase} returns its parameter unchanged.<a name="line.427"></a>
<span class="sourceLineNo">428</span>     * &lt;/p&gt;<a name="line.428"></a>
<span class="sourceLineNo">429</span>     *<a name="line.429"></a>
<span class="sourceLineNo">430</span>     * @param sql SQL statement<a name="line.430"></a>
<span class="sourceLineNo">431</span>     * @return SQL statement<a name="line.431"></a>
<span class="sourceLineNo">432</span>     */<a name="line.432"></a>
<span class="sourceLineNo">433</span>    public String limitSingleRow(String sql) {<a name="line.433"></a>
<span class="sourceLineNo">434</span>        return sql;<a name="line.434"></a>
<span class="sourceLineNo">435</span>    }<a name="line.435"></a>
<span class="sourceLineNo">436</span><a name="line.436"></a>
<span class="sourceLineNo">437</span>    /**<a name="line.437"></a>
<span class="sourceLineNo">438</span>     * Enquote a table or column name as necessary.<a name="line.438"></a>
<span class="sourceLineNo">439</span>     *<a name="line.439"></a>
<span class="sourceLineNo">440</span>     * &lt;p&gt;<a name="line.440"></a>
<span class="sourceLineNo">441</span>     * The implementation in {@link SQLKVDatabase} returns its parameter unchanged.<a name="line.441"></a>
<span class="sourceLineNo">442</span>     * &lt;/p&gt;<a name="line.442"></a>
<span class="sourceLineNo">443</span>     *<a name="line.443"></a>
<span class="sourceLineNo">444</span>     * @param name table or column name<a name="line.444"></a>
<span class="sourceLineNo">445</span>     * @return {@code name} enquoted as necessary for this database type<a name="line.445"></a>
<span class="sourceLineNo">446</span>     * @throws IllegalArgumentException if {@code name} is null<a name="line.446"></a>
<span class="sourceLineNo">447</span>     */<a name="line.447"></a>
<span class="sourceLineNo">448</span>    public String quote(String name) {<a name="line.448"></a>
<span class="sourceLineNo">449</span>        return name;<a name="line.449"></a>
<span class="sourceLineNo">450</span>    }<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span>    /**<a name="line.452"></a>
<span class="sourceLineNo">453</span>     * Wrap the given {@link SQLException} in the appropriate {@link KVTransactionException}.<a name="line.453"></a>
<span class="sourceLineNo">454</span>     *<a name="line.454"></a>
<span class="sourceLineNo">455</span>     * @param transaction the {@link SQLKVTransaction} in which the exception occured<a name="line.455"></a>
<span class="sourceLineNo">456</span>     * @param e SQL exception<a name="line.456"></a>
<span class="sourceLineNo">457</span>     * @return appropriate {@link KVTransactionException} with chained exception {@code e}<a name="line.457"></a>
<span class="sourceLineNo">458</span>     * @throws NullPointerException if {@code e} is null<a name="line.458"></a>
<span class="sourceLineNo">459</span>     */<a name="line.459"></a>
<span class="sourceLineNo">460</span>    public KVTransactionException wrapException(SQLKVTransaction transaction, SQLException e) {<a name="line.460"></a>
<span class="sourceLineNo">461</span>        if (e instanceof SQLTimeoutException)<a name="line.461"></a>
<span class="sourceLineNo">462</span>            return new TransactionTimeoutException(transaction, e);<a name="line.462"></a>
<span class="sourceLineNo">463</span>        if (e instanceof SQLRecoverableException)<a name="line.463"></a>
<span class="sourceLineNo">464</span>            return new RetryTransactionException(transaction, e);<a name="line.464"></a>
<span class="sourceLineNo">465</span>        if (e instanceof SQLTransientException)<a name="line.465"></a>
<span class="sourceLineNo">466</span>            return new RetryTransactionException(transaction, e);<a name="line.466"></a>
<span class="sourceLineNo">467</span>        return new KVTransactionException(transaction, e);<a name="line.467"></a>
<span class="sourceLineNo">468</span>    }<a name="line.468"></a>
<span class="sourceLineNo">469</span>}<a name="line.469"></a>
<span class="sourceLineNo">470</span><a name="line.470"></a>




























































</pre>
</div>
</body>
</html>
